Repository navigation
docs(log): the store writes run format v3, and Recovery.quarantined counts paths - #5
Merged
Merged
Conversation
The module doc said the writer writes v2 runs in the format RUN_MAGIC describes; Run::encode_blocks writes RUN_MAGIC_V3, front-coded blocks of BLOCK_PAIRS pairs behind an index of first keys, counts and lengths, which the book's runs page already gives. The doc now describes v3 and keeps v2 and v1 as formats readers accept. The code was right, so there is no failing test; a test reads the run a seal writes through the store and pins the v3 magic the doc now names.
The field's doc called it the entries found beyond the checkpoint that could not be replayed, but recover reports the length of the data writer's quarantined list: the tile and bundle paths beyond the tree state that Writer::open moved to .state/torn-<utc>, as the book's runs page says. The doc now says so. The code was right, so there is no failing test; a test leaves a bundle and a tile past the tree state and pins the count at two paths.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The store module doc now describes the run format the writer writes, v3, and
Recovery::quarantinedis documented as counting store paths that opening the store moved aside.RUN_MAGICdescribes;Run::encode_blockswritesRUN_MAGIC_V3, front-coded blocks ofBLOCK_PAIRSpairs behind an index of first keys, counts and lengths, which the book's runs page already gives. The doc now describes v3 and keeps v2 and v1 as formats readers accept. A test reads the run a seal writes and pins the v3 magic.Recovery::quarantinedfield's doc called it the entries found beyond the checkpoint that could not be replayed, but recover reports the length of the data writer's quarantined list: the tile and bundle paths beyond the tree state thatWriter::openmoved to.state/torn-<utc>. A test leaves a bundle and a tile past the tree state and pins the count at two paths.The branch has towncrier fragments.